Skip to content

docs: correct the Koyeb deployment flow - #729

Merged
cevheri merged 1 commit into
libredb:mainfrom
2160039878-cyber:docs/koyeb-deploy-flow-668
Sep 9, 2026
Merged

docs: correct the Koyeb deployment flow#729
cevheri merged 1 commit into
libredb:mainfrom
2160039878-cyber:docs/koyeb-deploy-flow-668

Conversation

@2160039878-cyber

@2160039878-cyber 2160039878-cyber commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Description

The Koyeb steps describe a nonexistent Blueprint file and leave secret setup unfinished. Replace them with the existing deploy-button flow and the documented credentials and storage options.

Type of Change

  • Documentation update

Related Issue

Closes #668

Changes Made

Every replacement claim was checked against deploy/koyeb/README.md: GHCR latest image, manually supplied credentials, local browser storage by default, and PostgreSQL storage for redeploy persistence. The Koyeb block links to the existing deploy button and detailed guide and no longer refers to forking or koyeb.yaml. bun run readme:check passed. Documentation only; no cloud deployment was performed and the issue explicitly requires no new test.

Testing

  • Local: bun run readme:check passed.
  • Linux CI on the exact PR commit b38d279: 14,713 tests passed, all 391 isolated core files and 34 component groups passed; 46324/46324 lines covered (100%). Ran the unfiltered bun run test:coverage and bun run coverage:check scripts.
  • The same run passed formatting, lint, typecheck, knip, README/chart/channel/security guards, application and library builds, Helm lint, and Node 24/26 engine smoke tests.
  • Playwright: 65 passed / 1 flaky (passed on retry) / 6 skipped under the existing configuration, plus 1 subpath, 1 PostgreSQL functional smoke, 3 tarball, and 3 npx tests passed.
  • Secret Scan passed after fetching all fork branch history, including this commit; no leaks found.

I did not complete bun run test / full coverage, the Helm checks, and E2E locally on Windows: the existing SQLite cleanup hits EBUSY, and Docker Desktop is unavailable. The unchanged upstream workflow ran the complete coverage/test layers and the other checks above on Linux instead. SonarCloud is the sole failed job in that fork run: access to the upstream project returns 401 / Not authorized or project not found. Upstream CI already skips SonarCloud for external fork PRs; no workflow or coverage gate was changed.

Test Environment

LibreDB Studio 0.15.0; Windows local / Ubuntu CI; Bun 1.4.2; Node 24 (plus Node 26 smoke); Chromium and WebKit; PostgreSQL functional smoke.

Checklist

  • Claimed the linked issue before editing; branch starts from main.
  • Reviewed the diff and followed the existing style.
  • Documentation only: the issue explicitly requires no new test.
  • All executable test/build jobs pass on the exact commit in Linux CI.

Additional Notes

AI-assisted implementation and validation using Codex, disclosed in the issue claim. Only documentation changes. No provider code changes, so the provider code/doc/test triad is not applicable. No dependent changes or screenshots are needed.

CI follow-up

The fork-run SonarCloud 401 is tracked in #732 and fixed by #733. The inherited condition admitted fork-owned pushes and fork-local PRs to the canonical SonarCloud project. The dedicated CI fix run now succeeds: all nine executable test/build jobs pass, and SonarCloud is scoped to the canonical repository. That run tests CI fix commit 80a318b; this PR's exact-head verification remains the original run linked above, whose nine executable jobs passed. Upstream Actions still await maintainer approval.

@cevheri cevheri added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 9, 2026
@cevheri

cevheri commented Sep 9, 2026

Copy link
Copy Markdown
Member

Checked against #668. All five "Done when" items hold. The fork step and the koyeb.yaml step are gone, step 4's dangling colon is gone, and the block points at both the deploy button and deploy/koyeb/.

Item 4 was the one worth checking properly, and it holds claim by claim: the ghcr.io/libredb/libredb-studio:latest image is deploy/koyeb/README.md:20, "Koyeb cannot auto-generate secrets" and the placeholder note are lines 34 to 36, the 32-character floor is line 34, and the Postgres-or-Neon persistence sentence is lines 42 to 43, close to verbatim. Taking the wording from the source of truth instead of writing your own sentence is what keeps a fix like this true a year from now, and it is the second time today you have done it.

I also checked that the #one-click-deploy anchor resolves to README.md:583 and that the Koyeb button really sits in that section, so the link sends people where you say it does.

Merging shortly.

@cevheri
cevheri merged commit c9e52de into libredb:main Sep 9, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README's Koyeb deploy steps tell you to fork the repo for a koyeb.yaml that does not exist

2 participants